Skip to main content

Get Files with SecureFTP

Description

Get a file with SFTP is a Process Entry in the File Transfer plugin for Process Studio Processes. Get a file with SFTP process entry retrieves one or more files via an FTP server using the Secure FTP protocol.

Configurations

No.Field NameDescription
1Process Entry nameSpecifies the unique name of the process entry on the workspace area. A process entry can be placed on the canvas several times, yet it represents the same process entry.
2SFTP-server name / IPThe name of the SFTP server or the IP address
3PortThe TCP port to use. This is usually 22
4User nameThe user name to log into the SFTP server
5PasswordThe password to log into the SFTP server
6Use private keyfileIndicates whether or not a private keyfile is to be used.
7Private key filenameIf "Use private keyfile" is checked then this field is enabled. The
file can be browsed to using the browse button to the right of the field. The Private Key should be in the PEM file format. For PuTTY-based Private Keys, use PuTTYgen to convert the file into "OpenSSH" format.
8Key passphraseIf "Use private keyfile" is checked then this field is enabled. If a passphrase is required then enter it here.
9Proxy typeSelect from the list: HTTP/SOCKS5
10Proxy hostProxy server host name
11Proxy portProxy server port number
12Proxy usernameProxy server account user name
13Proxy passwordProxy server account password
14CompressionSelect from the list: none/zlib
Files tab:
Source (remote) files:
1Copy previous results to argsIf files to send are dynamically generated by another workflow or if you want to identify files to sent, check this option.PROCESS STUDIO will select files list from previous result rows (not result files) and send theses files.
2Remote DirectoryThe remote directory on the SFTP server from which we get the files. Use the "test folder" button to connect to the remote server and validate that the folder exists.
3Wildcard (regular expression)Specify a regular expression here if you want to select multiple files.
4Group: Last Modified On (UTC Time) FromSpecify a date-time here if you want to select files that are last modified from this time. (Supported DateTime format: “yyyy- MM-dd hh:mm:ss a”)
5ToSpecify a date-time here if you want to select files that are last modified to this time. (Supported DateTime format: “yyyy-MM-dd hh:mm:ss a”)
6Remove files after retrievalEnable checkbox to delete the remote file after the file is transferred.
Target (local) files:
1Target DirectoryThe remote directory on the SFTP server from which we get the files. Use the "test folder" button to connect to the remote server and validate that the folder exists.
2Create target folderCheck this option if the destination folder does not exist and should be created.
3Add filenames to resultIf checked the name of the file is added to the result stream.